Coding Conventions - 大纲

目录结构

1. Coding Conventions
2. 正文
3. Indentation
4. 悬挂缩进
5. 函数定义也是同样道理
6. Maximum Line Length
7. Blank lines
8. 1. 顶层函数和类之间空两行
9. 2. 类中的方法之间空一行
10. 3. 函数内部可以少量使用空行
11. 4. 装饰器与定义之间不要空行
12. White spaces
13. 1. 括号内部不要加无意义空格
14. 2. 逗号、分号、冒号前不留空格
15. 3. 切片中的冒号是特殊情况
16. 8. 二元运算符两侧通常各一个空格
17. 赋值运算符
18. 增强赋值
19. 比较运算符
20. 成员运算符
21. 身份运算符
22. 布尔运算符
23. 9. 普通赋值中的 `=` 两侧有空格
24. 10. 关键字参数中的 `=` 两侧不加空格
25. 11. 无类型注解的默认参数也不加空格
26. Naming Conventions
27. 不同对象的推荐命名
28. 变量：snake_case
29. 函数：snake_case，并使用动词
30. 类：PascalCase，并使用名词
31. 模块：简短、全小写
32. 包：简短、全小写，尽量不用下划线
33. 实践中的推荐规则
34. Comments
35. Block comment：块注释
36. Inline comment：行内注释
37. DocString
38. Google 风格